README: restructure as a pattern index with mermaid shapes - #15
Conversation
Shift the entry point from philosophy-first to problem-first: - Replace the top-of-file "Philosophy" section with a "Choose a pattern" use-case index. Readers match their problem to a pattern without having to learn the ontology first. - Add an abstract mermaid flowchart to each pattern card so the shape is scannable at a glance. Concrete class-name flows are kept below as reference. - Drop the Beginner/Intermediate/Advanced level labels; complexity is already implied by ordering and the diagrams. - Drop the numeric "At a glance" counts table; the shapes convey the same information visually. - Move the six-layer vocabulary table into a "Background" section at the end with links to CLAUDE.md, GLOSSARY.md and PHILOSOPHY.md. - Rename the title from "BE Framework Demos" to "Be Framework Patterns" to match the repository rebrand. - Fix the stale `composer test` instruction (no root composer exists; each demo installs independently). Japanese README mirrors all of the above.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 46 minutes and 43 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME files reframed the project from "BE Framework Demos" to "Be Framework Patterns". Reorganized content by replacing Philosophy sections with pattern decision tables and Mermaid flow diagrams, added Background section documenting six-layer vocabulary, linked to docs/patterns.json catalog, and revised test execution instructions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.ja.md`:
- Around line 71-83: The README diagrams/text currently present a Being-centric
flow but the catalog patterns 'diamond', 'cascade-diamond', and
'complex-convergence' are defined as moment-driven (being: 0); update the
README.ja.md descriptions and Mermaid diagrams (the "フロー: Input → [並列Beings] →
[並列Moments] → Final" block and the associated captions) to reflect Moment-driven
convergence semantics by removing Being-centric intermediate flows, showing
Moments as the drivers that converge to Final, and updating labels/captions
accordingly (alternatively, if the README was correct, update the three pattern
entries in docs/patterns.json to set being>0 and adjust their convergence
semantics—pick one source of truth and make the README and the
'diamond'/'cascade-diamond'/'complex-convergence' definitions consistent).
In `@README.md`:
- Around line 71-83: The README's pattern diagrams/descriptions for "Diamond",
"Cascade Diamond", and "Complex Convergence" conflict with docs/patterns.json
which defines these patterns as being: 0 and Moment-centric; update README.md so
those three pattern sections (and their mermaid diagrams) remove explicit Being
intermediates and instead describe/render Moment-centric convergence consistent
with docs/patterns.json's "being: 0" model (or if you prefer the README version,
update docs/patterns.json entries for Diamond, Cascade Diamond, and Complex
Convergence to include the corresponding Being counts and Moment flow and ensure
the JSON "being" field and convergence description match the README); make sure
the pattern names and examples in README.md exactly mirror the structure and
fields in docs/patterns.json.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
CodeRabbit pointed out that the Diamond, Cascade Diamond, Complex Convergence and blog-publishing cards described Being-centric flows that don't match docs/patterns.json (which is the ground truth, verified against the source): - order-processing (diamond): being=0, moment=3 — Input goes directly to OrderConfirmed, which injects three Moments. The old ASCII/mermaid showed three parallel Being chains that are not in the #[Be] graph. - loan-application (cascade-diamond): being=0, moment=2 — Input goes directly to LoanApproved, which injects two Moments. The "cascade" is internal to the Moments' Potentials, not a two-stage Being pipeline. - insurance-claim (complex-convergence): being=0, moment=5, final=2 — both Inputs declare #[Be([ClaimSettled, ClaimEscalated])] and Moments are shared across both Finals. The old diagram showed a single converging Being followed by a fan-out. - blog-publishing (staged-sequential): being=1, moment=0 — externally Linear. The distinctive feature is a single Being that orchestrates several Reason services, not a 3-Being / 2-Moment chain. Fix: - Rewrite the four mermaid diagrams to match the live #[Be]/#[Inject] graph; use dashed arrows for injected Moments. - Rename "Sequential + Moments" to "Multi-Reason Being" and rewrite the description to be about Reason orchestration. - Update the "Choose a pattern" use-case descriptions for the four affected rows. - Add a diagram legend at the top of the catalog explaining solid vs dashed arrows. README.ja.md mirrors all of the above.
|
@coderabbitai 指摘ありがとうございます。
README.ja.md も同様に反映しています。 |
|
Tip For best results, initiate chat on the files or code changes.
修正内容を確認しました。ありがとうございます！ If you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
Follow up on be-framework/be-patterns#14 (namespace rename) and be-framework/be-patterns#15 (README restructure): rename be-demos references to be-patterns and replace the removed Beginner/ Intermediate/Advanced listing with the new pattern index. Fixes #4
1 participant
Summary
Shifts the README from a philosophy-first doc to a problem-first pattern index, so a reader can match their use case to a pattern in seconds.
Key changes
Follow-up (separate repo, not this PR)
`be-framework/be-skills` `be/SKILL.md` references this README and will need a companion update:
Test plan
Summary by CodeRabbit
Documentation